API docs by Redocly

SISIAO - API MENAGE (1.1.0)

Download OpenAPI specification:

API du SI-SIAO pour la gestion des MENAGE

MenagePublic

API du module MENAGE SISIAO

Etat de l'application

API permettant de visualiser l'état de fonctionnement du module MENAGE de l'application SIAO MENAGE

Responses

Response samples

Content type
application/json
{
  • "version": "version",
  • "status": true
}

Consulter les informations d'un ménage

path Parameters
cleMenage
required
string <= 36 characters

Clé SISIAO du ménage

header Parameters
tracabiliteIdentite
required
string <byte>

Objet encodé en base 64 - voir documentation technique détaillant l'objet JSON attendu. Exemple : {"codeDispositif": "string", "nom": "string", "prenom": "string", "email": "string", "telephone": "string", "identifiantUtilisateurExterne": "string"}

Responses

Response samples

Content type
application/json
{
  • "menage": null,
  • "personnes": [
    ]
}

Modifier les informations d'un ménage

path Parameters
cleMenage
required
string <= 36 characters

Clé SISIAO du ménage

header Parameters
tracabiliteIdentite
required
string <byte>

Objet encodé en base 64 - voir documentation technique détaillant l'objet JSON attendu. Exemple : {"codeDispositif": "string", "nom": "string", "prenom": "string", "email": "string", "telephone": "string", "identifiantUtilisateurExterne": "string"}

Request Body schema: application/json
required
required
object (MenageInformations)

Responses

Request samples

Content type
application/json
{
  • "menage": {
    }
}

Response samples

Content type
application/json
{
  • "version": 0
}

Consulter les informations d'une personne

path Parameters
clePersonne
required
string <= 36 characters

Clé SISIAO de la personne

header Parameters
tracabiliteIdentite
required
string <byte>

Objet encodé en base 64 - voir documentation technique détaillant l'objet JSON attendu. Exemple : {"codeDispositif": "string", "nom": "string", "prenom": "string", "email": "string", "telephone": "string", "identifiantUtilisateurExterne": "string"}

Responses

Response samples

Content type
application/json
{
  • "personne": null
}

Modifier les informations d'une personne

path Parameters
clePersonne
required
string <= 36 characters

Clé SISIAO de la personne

header Parameters
tracabiliteIdentite
required
string <byte>

Objet encodé en base 64 - voir documentation technique détaillant l'objet JSON attendu. Exemple : {"codeDispositif": "string", "nom": "string", "prenom": "string", "email": "string", "telephone": "string", "identifiantUtilisateurExterne": "string"}

Request Body schema: application/json
required
required
object (PersonneSocle3_personne)

Responses

Request samples

Content type
application/json
{
  • "personne": null
}

Response samples

Content type
application/json
{
  • "version": 0
}

Ajouter un projet résidentiel et d'accompagnement à des personnes

path Parameters
cleMenage
required
string <= 36 characters

Clé SISIAO du ménage

header Parameters
tracabiliteIdentite
required
string <byte>

Objet encodé en base 64 - voir documentation technique détaillant l'objet JSON attendu. Exemple : {"codeDispositif": "string", "nom": "string", "prenom": "string", "email": "string", "telephone": "string", "identifiantUtilisateurExterne": "string"}

Request Body schema: application/json
required
personnes
required
Array of strings[ items <= 36 characters ]

Liste des clés SISIAO des personnes concernées par le projet résidentiel et d'accompagnement

required
object (RapportSocial)
object (BesoinsAccompagnement)
object (ProjetResidentiel)

Responses

Request samples

Content type
application/json
{
  • "projetResidentiel": {
    },
  • "rapportSocial": {
    },
  • "personnes": [
    ],
  • "besoinsAccompagnement": {
    }
}

Response samples

Content type
application/json
{
  • "cleBesoinResidentielAccompagnement": "cleBesoinResidentielAccompagnement",
  • "version": 0
}